/**
 * Copyright 2008 Adam Ruggles.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package kiff.util.filter;

import kiff.exception.FilterException;

/**
 * Text Filter interface, a text filter is used to filter out data from the text and return the filtered text.
 * @author Adam
 * @version $Id: TextFilter.java 38 2008-09-21 07:40:51Z a.ruggles $
 */
public interface TextFilter {
	/**
	 * Returns the filtered text.
	 * @param text The text to filter.
	 * @return The filtered text.
	 * @throws FilterException If an error occurs in filtering the text.
	 */
	String filter(String text) throws FilterException;
}
